CygNet .NET API
A .NET API is provided to allow programmatic access to CygNet services, clients, and other related entities.
Important: The .NET API requires the Microsoft .NET Framework is installed on the host computer, in accordance with the CygNet system requirements. See the
CygNet v9.8 System Requirements for more information.
.NET Assemblies
The .NET assemblies can be found in the \Bin directory of your CygNet installation, with the exception of the CygNet.Notifications.dll. The base .dlls work alongside the suffixed ones (32, 64), which are automatically loaded for a selected process. If the base .dlls are put into the Windows Global Assembly Cache (GAC), then the suffixed ones must be as well, and if the base .dlls are deployed alongside the target applications, then the suffixed ones must also be deployed. Any CPU targeting applications must deploy all three .dlls. x86 targeting apps only need to deploy the base and the 32.dll. x64 targeting apps only need to target the base .dll and the 64.dll.
The following table describes the .NET assemblies available in CygNet v9.8.
| Assembly .dlls | Description | API Help |
|---|---|---|
|
CygNet.API.AccessControl.dll CygNet.API.AccessControl32.dll CygNet.API.AccessControl64.dll |
Provides programmatic access to the CygNet Access Control (ACS) service. |
|
|
CygNet.API.Alarms.dll CygNet.API.Alarms32.dll CygNet.API.Alarms64.dll |
Provides programmatic access to the Common Alarm Service (CAS). |
|
|
CygNet.API.Cache.dll CygNet.API.Cache.Alarms.dll CygNet.API.Cache.Alarms32.dll CygNet.API.Cache.Alarms64.dll CygNet.API.Cache.Common.dll CygNet.API.Cache.Facilities.dll CygNet.API.Cache.Facilities32.dll CygNet.API.Cache.Facilities64.dll CygNet.API.Cache.Points.dll CygNet.API.Cache.Points32.dll CygNet.API.Cache.Points64.dll |
Provides programmatic access to miscellaneous cache entities. | |
|
CygNet.API.Core.dll CygNet.API.Core32.dll CygNet.API.Core64.dll |
Provides programmatic access to miscellaneous core CygNet entities. Note: Includes CygNet.API.Core.COM.ServiceInformation namespace, which is a wrapper around CygNet.API.Core.ServiceInformation for access to general service features in COM. .NET Framework consumers should use CygNet.API.Core.ServiceInformation instead. |
|
|
CygNet.API.Devices.dll CygNet.API.Devices32.dll CygNet.API.Devices64.dll |
Provides programmatic access to the CygNet Device Definition Service (DDS) (via a ConfigClient) and the CygNet Universal Interface Service (UIS) (via a PollingClient). Interfaces are available to access devices, device templates, device facility links, data groups, data group elements, data group transactions, UIS commands and command components, etc., via script. |
|
|
CygNet.API.Facilities.dll CygNet.API.Facilities32.dll CygNet.API.Facilities64.dll |
Provides programmatic access to the CygNet Facility (FAC) service, plus other helpful facility-related methods. Note: Includes CygNet.API.Facilities.Relative namespace, which provides relative facility definitions and associated methods. |
|
|
CygNet.API.Groups.dll CygNet.API.Groups32.dll CygNet.API.Groups64.dll |
Provides programmatic access to the CygNet Group Service (GRP) service. |
|
|
CygNet.API.Historian.dll CygNet.API.Historian32.dll CygNet.API.Historian64.dll |
Provides programmatic access to the CygNet Historian, plus other history-related enumerations. CygNet.API.Historian allows for the storage and retrieval of extended data, including rollups. See VHS Extensibility for more information about extended data. |
|
|
CygNet.API.JobRunner.dll |
Provides programmatic access to Job Runner. |
|
|
CygNet.API.Logger.Desktop.dll CygNet.API.Logger.dll |
||
|
CygNet.API.Notifications.dll CygNet.API.Notifications32.dll CygNet.API.Notifications64.dll |
Provides programmatic access to the CygNet General Notification Service (GNS) service. |
|
|
CygNet.API.Points.dll CygNet.API.Points32.dll CygNet.API.Points64.dll |
Provides programmatic access to the CygNet Point (PNT) service, access to the connected CygNet Current Value Service (CVS), plus other helpful points-related methods. |
|
|
CygNet.API.Schedules32.dll CygNet.API.Schedules64.dll |
Provides programmatic access to the CygNet Master Scheduling Service (MSS). Methods are available to schedule command tasks (UIS, FMS, and Set Info Keyword), SetPoint tasks, and blackouts via script. See MSS Scripting. |
|
|
CygNet.API.ServiceManager.dll CygNet.API.ServiceManager32.dll CygNet.API.ServiceManager64.dll |
Provides programmatic access to the CygNet Remote Service Management (RSM) service, including Automatic Service Recovery. Note: Includes CygNet.API.ServiceManager.COM namespace, which is a wrapper around CygNet.API.ServiceManager.Client for access to the CygNet RSM service in COM. .NET Framework consumers should use CygNet.API.ServiceManager.Client instead. |
|
|
CygNet.API.WellTest.dll CygNet.API.WellTest.Controls.dll |
Provides programmatic access to CygNet Well Test Module and Canvas Well Test control. |
See
|
|
CygNet.COMAPI.dll CygNet.COMAPI64.dll |
||
|
CygNet.Core.dll CygNet.Core32.dll CygNet.Core64.dll |
Provides programmatic access to miscellaneous core CygNet entities. Note: Includes CygNet.Core.ReadOnlyCollectionHelpers namespace, which provides extension methods to convert from the more capable collection interfaces to the ReadOnly variants. |
|
|
CygNet.Data.Alarms.dll |
Represents miscellaneous alarm entities. |
|
|
CygNet.Data.Cache.dll |
Represents miscellaneous caching entities. |
|
|
CygNet.Data.Core.dll |
Represents miscellaneous core CygNet entities. |
|
|
CygNet.Data.Devices.dll |
Represents miscellaneous device entities. |
|
|
CygNet.Data.Facilities.dll |
Represents miscellaneous facility entities. |
|
|
CygNet.Data.Groups.dll |
Represents miscellaneous group entities. |
|
|
CygNet.Data.Historian.dll |
Encapsulates miscellaneous Historian entities. |
|
|
CygNet.Data.Notifications.dll |
Represents miscellaneous notification entities. |
|
|
CygNet.Data.Points.dll |
Encapsulates miscellaneous Point entities. Note: Includes CygNet.Data.Points.EnhancedAlarmConfig namespace, which provides methods for writing Enhanced Alarm Configuration (EAC) conditions, definitions, expressions, and reference points. See Enhanced Alarm Configuration. |
|
|
CygNet.Data.Schedules.dll |
Represents miscellaneous schedules entities. |
|
|
CygNet.Data.ServiceManager.dll |
Encapsulates CygNet service details. Note: Includes CygNet.Data.ServiceManager.COM namespace, which provides a COM interface for several interfaces: IFailoverSet, IFailoverStatus, IFailoverStep, IServiceDetails, IServiceInfo, IServiceInfoCache, and IZoneData. .NET Framework consumers should not use this interface. Note: Includes CygNet.Data.ServiceManager.Redundancy namespace, which provides Redundancy methods: DomainDetails, FailoverSet, FailoverStatus, FailoverStep, FailoverTriggerDetails, NetworkDetails, ZoneData, and ZoneDetails. |
|
|
Encapsulates the details of a CygNet GNS notification, and the interface for a Notification plugin. Note: CygNet.Notifications.dll can be found in CygNet\Services\GNS folder. |
|
|
|
CygNet.Internal.Core.dll CygNet.Internal.Core32.dll CygNet.Internal.Core64.dll |
||
|
CygNet.Internal.SettingsPackage.dll |
|
|
|
CygNet.UI.dll CygNet.UI32.dll CygNet.UI64.dll |
Version Managing .NET Files
See .rsq File for information about version managing these .NET assemblies.
Online Help
A standalone online help file CygNet.API.chm is available for user assistance and can be found in the CygNet\Bin directory.
